package com.autumn.swagger.annotation;

import java.lang.annotation.*;

/**
 * Swagger组信息
 *
 * @author xinghua
 * @date 2018/12/20
 * @since 1.0.0
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
public @interface ApiGroup {
	
	/**
	 * 字段 groupName
	 */
	public static final String FILED_GROUP_NAME = "groupName";
	
	/**
	 * 字段 packages
	 */
	public static final String FILED_PACKAGES = "packages";
	
	/**
	 * 字段 annotation
	 */
	public static final String FILED_ANNOTATION = "annotation";

    /**
     * 组名称
     *
     * @return 组名称
     */
    String groupName() default "default";    

    /**
     * 组包含的 API 的包
     *
     * @return 组包含的 API 的包
     */
    String packages() default "";

    /**
     * 组包含的 API 的注解
     *
     * @return 组包含的 API 的注解
     */
    Class<? extends Annotation> annotation() default Annotation.class;
}
